Skip to content

Release version 3.0.3#45

Merged
EGJ-Moorington merged 10 commits intomainfrom
dev
Jan 26, 2026
Merged

Release version 3.0.3#45
EGJ-Moorington merged 10 commits intomainfrom
dev

Conversation

@EGJ-Moorington
Copy link
Copy Markdown
Owner

EGJ-Moorington and others added 10 commits January 8, 2026 20:15
Updated `pre-commit` hooks to their latest version, changed the order of `ruff` hooks, updated licencing information for `examples.rst` and added missing licencing text.
Changed `ruff.toml` so `ruff` uses Python 3.13 when checking files in `tests/` and `docs/`.
Created a `pre-commit` hook which synchronises examples in `README.rst` with examples in `examples`.
…admes-usage-example

Created a `pre-commit` hook to update examples in `README`

Created a `pre-commit` hook which synchronises examples in `README.rst` with examples in examples.

Closes #39
Fixed `readme-example-updater` `pre-commit` hook to trigger when examples are updated.
Improved the `readme-example-updater` `pre-commit` hook to raise a warning when including non-existent example files in `README.rst`.
Cleaned examples up by removing unused imports, adding docstrings, renaming files for better readability and adding a simpler example for double button set-ups.
Reverted `examples/button_handler_simpletest.py` rename so that `pytest` does not test it.
Updated docs to use the new example paths and include the new exmple.
Cleaned examples up by:
- Changing file names.
- Removing unused imports.
- Adding a short description of the example in each of the files' docstring.
- Creating a simpler two button set-up usage example.
- Improving the `readme-example-updater` `pre-commit` hook to raise a warning when a non-existent file is included in `README.rst`.
- Fixing the `readme-example-updater` `pre-commit` hook to trigger when examples are updated.

Closes #43
@EGJ-Moorington EGJ-Moorington added this to the Version 3.0.3 milestone Jan 26, 2026
@EGJ-Moorington EGJ-Moorington self-assigned this Jan 26, 2026
@EGJ-Moorington EGJ-Moorington added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Jan 26, 2026
@EGJ-Moorington EGJ-Moorington merged commit 4133148 into main Jan 26, 2026
2 checks passed
adafruit-adabot pushed a commit to adafruit/CircuitPython_Community_Bundle that referenced this pull request Jan 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clean examples up Automatically update README's usage example

1 participant